Selam Ainalem Amperes by SelamawitA · Pull Request #24 · Ada-C9/api-muncher

SelamawitA · 2018-05-07T05:52:39Z

API Muncher

Congratulations! You're submitting your assignment!

Comprehension Questions

Question	Answer
How did you go about exploring the Edamam API, how did you try querying the API?	I heavily relied on postman to play with the API as well as reading the documentation. On parts of the documentation that weren't as clear (r = uri for example) copying the examples and running the request myself in Postman made the connections and the requirements more clear.
Describe your API Wrapper. How did you decide on the methods you created?	My design was driven by relying on the methods provided by the API, realistically I know that more API calls = $$ but it seemed more efficient for this project to rely on the API for calling a single recipe, list from a query, range of queries over pulling on large set of a search, storing it somewhere and having to constantly search.
Describe an edge case or failure case test you wrote for your API Wrapper.	The case of a non-string type entered for a query. I added a condition to return an empty array in the event that this occurs.
Explain how VCR aids in testing an API.	VCR's store calls to APIs made by tests so if tests need to be run/updated multiple times the data from the original API call can be referenced, limiting the overall cost of API usage.
What is the Heroku URL of your deployed application?	https://limitless-wildwood-28723.herokuapp.com/
Provide a link to the Trello board you used	https://trello.com/b/N2UFecmf/recipeapi

…tion, and added test file for recipe_api_wrapper class.

…e able to sign in with their github (attempted with google but the process kept rejecting clientID).

…onsive to size changes.

…s to show page of a recipe. Added flash messages (and some styling) for reminder to log-in and successful search.

…ted small aspects to flash message.

…ccounted for properly in conditions in wrapper class, and made update to css styling.

CheezItMan · 2018-05-09T16:26:35Z

API Muncher

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	good number of commits and good commit messages
Comprehension questions	Check
General
Rails fundamentals (RESTful routing, use of named paths)	Check
Semantic HTML	You've got some broken HTML in your layout file
Errors are reported to the user	For search results with no recipes, yes. For incorrect URIs for the show action, no.
API Wrapper to handle the API requests	Check, see my notes in your code
Controller testing	Check,
Lib testing	Check, see my notes
Search Functionality	Check
List Functionality	Check
Show individual item functionality (link to original recipe opens in new tab)	Check
Styling
Responsive layout	The search results are nicely responsive, the show actions, not so much
List View shows 10 items at a time/pagination	Check
The app is styled to create an attractive user interface	The styling looks pretty good.
API Features
The App attributes Edaman	Check
The VCR casettes do not contain the API key	Check, nice that you're also filtering the github ID and secret.
External Resources
Link to Trello Board	Yes, but I can't access it.
Link to deployed app on Heroku	Check
Overall	Nice work, you hit the major learning goals. You have some things to work on including through testing and making sure you handle errors, but you did overall a nice job here.

CheezItMan · 2018-05-09T16:04:27Z

app/views/layouts/application.html.erb

+    <%= javascript_include_tag "application", 'data-turbolinks-track' => true %>
+    <%= csrf_meta_tags %>
+  </head>
+  <nav>


This nav element should be in the body

CheezItMan · 2018-05-09T16:13:45Z

app/views/layouts/application.html.erb

+<%end%>
+  </nav>
+
+  <%if params[:query].nil?%>


Maybe simply put main elements with these ids in the views for homepage and search etc.

CheezItMan · 2018-05-09T16:16:11Z

app/views/recipe/show.html.erb

@@ -0,0 +1,40 @@
+
+<h2 class="item-header"><%=@recipe.label%></h2>
+<h3 class="item-header">By <%=@recipe.source%></h3>


This would be an excellent point for a link back to the source of the recipe.

CheezItMan · 2018-05-09T16:17:59Z

app/controllers/recipe_controller.rb

+  end
+
+  def show
+    @recipe = RecipeApiWrapper.a_recipe(params[:uri])


You should have some error handling for if a recipe isn't found.

CheezItMan · 2018-05-09T16:18:56Z

lib/recipe_api_wrapper.rb

+      return []
+    end
+    a_recipe = recipe.uri_encode
+    response = HTTParty.get("https://api.edamam.com/search?app_id=#{APP_ID}&app_key=#{APP_KEY}&r=#{a_recipe}")


You should do some error handling for if the API request doesn't work. What if the URI is incorrect? How do you handle it?

CheezItMan · 2018-05-09T16:19:41Z

test/lib/recipe_api_wrapper_test.rb

+        end
+      end
+      it 'will return [] for a recipe search that is not of string type' do
+        VCR.use_cassette("recipe-is-a-string") do


What about a call with a URI that's not valid?

CheezItMan · 2018-05-09T16:20:38Z

lib/recipe_api_wrapper.rb

+    return recipe
+  end
+
+  def self.limited_query(query,from,to)


This looks like a great candidate for combining with the list_of_queried_recipes method using default parameters for the from and to fields.

CheezItMan · 2018-05-09T16:21:52Z

test/controllers/recipe_controller_test.rb

+      it 'will display index for query within a specific range' do
+        session[:user_id].must_equal @jay.id
+        VCR.use_cassette("Recipe-controller:recipe-query-range") do
+          get query_results_path, params: {from:"1", to: "5", query: "corn"}


You should also test with invalid from and to fields

CheezItMan · 2018-05-09T16:22:04Z

test/controllers/recipe_controller_test.rb

+      end
+    end
+    describe 'Show' do
+      it 'will show details of a recipe' do


What about invalid uris

CheezItMan · 2018-05-09T16:23:15Z

test/controllers/recipe_controller_test.rb

+  end
+  describe 'Logged-in User' do
+    before do
+      login(@jay)


Very good that you're doing this testing.

SelamawitA added 18 commits May 2, 2018 13:57

added rails app to folder

aebeeba

updated views to reflect pagination, updated .env file for app protec…

950ccc0

…tion, and added test file for recipe_api_wrapper class.

added some nominal testing for recipe api wrapper class

8a2e0ed

added grid to organize recipe query, added oauth for guest users to b…

9550356

…e able to sign in with their github (attempted with google but the process kept rejecting clientID).

updated routes

d2455d0

removed require pry from program and updated config to .eager_load_paths

e9965c9

added homepage button

84a6636

added additional styling and reference to Edamam API

c40c63c

modified position of pagination

466a893

updated design from grid to flexbox for search images to be more resp…

0ce7a7d

…onsive to size changes.

added filter to recipe controller requiring user to sign in for acces…

3ab3df0

…s to show page of a recipe. Added flash messages (and some styling) for reminder to log-in and successful search.

added additional testing to recipe_api_wrapper.rb

87ac603

removed count from Recipe.rb

214f3fb

added testing for Recipe.rb class

c294492

added testing to recipe controller, show pg testing not passing, upda…

9f0e011

…ted small aspects to flash message.

fixed typo

efe30fc

fixed small error in test setup - params come in as strings was not a…

5c64f4a

…ccounted for properly in conditions in wrapper class, and made update to css styling.

updated tests

ee1f815

CheezItMan reviewed May 9, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Selam Ainalem Amperes#24

Selam Ainalem Amperes#24
SelamawitA wants to merge 18 commits intoAda-C9:masterfrom
SelamawitA:master

SelamawitA commented May 7, 2018 •

edited

Loading

Uh oh!

CheezItMan commented May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1,40 @@

		<h2 class="item-header"><%=@recipe.label%></h2>
		<h3 class="item-header">By <%=@recipe.source%></h3>

Conversation

SelamawitA commented May 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Muncher

Comprehension Questions

Uh oh!

CheezItMan commented May 9, 2018

API Muncher

What We're Looking For

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SelamawitA commented May 7, 2018 •

edited

Loading